/*
 * TMap Designer - A Thematic Map design software
 * Copyright (C) 2006 World Health Organization
 * http://www.who.int
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package who.tmap.bo.cd;

import java.util.Map;

import who.tmap.bo.BizObject;
import who.tmap.toolkit.shape.MapShape;

/**
 * CartographicDisplay marker interface
 * @author stl
 *
 */
public interface CartographicDisplay extends BizObject {

	/**
	 * Set the attributes column name containing data to represent
	 * @param dataColumnName the column name
	 */
	void setDataColumnName( String dataColumnName );
	
	/**
	 * Get the attributes column name containing data to represent
	 * @return the column name
	 */
	String getDataColumnName();
	
	/**
	 * Set the attributes column name containing the polygons ids 
	 * @param joinIdColumnName the column name
	 */
	void setJoinIdColumnName( String joinIdColumnName );
	
	/**
	 * Get the attributes column name containing the polygons ids 
	 * @return
	 */
	String getJoinIdColumnName();
	
	/**
	 * Set data to represent as a Map. Key is polygon, value is data to represent
	 * @param polygonAssociatedData the data to represent
	 */
	void setPolygonAssociatedData( Map<MapShape, Object> polygonAssociatedData );
	
	/**
 	 * Get data to represent as a Map. Key is polygon, value is data to represent
	 * @return the data to represent
	 */
	Map<MapShape,Object> getPolygonAssociatedData();
	
	/**
	 * Set CD Type
	 * @param type the cd type
	 */
	void setType( int type );
	
	/**
	 * Get CD Type
	 * @return the cd type
	 */
	int getType();
	
	int getCDDataType();

	
}
